Skip to content

Open keyboard automatically on Android magic code screen#90771

Merged
rlinoz merged 13 commits into
Expensify:mainfrom
wildan-m:wildan/80025-android-keyboard-magic-code
Jun 8, 2026
Merged

Open keyboard automatically on Android magic code screen#90771
rlinoz merged 13 commits into
Expensify:mainfrom
wildan-m:wildan/80025-android-keyboard-magic-code

Conversation

@wildan-m

@wildan-m wildan-m commented May 15, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

On Android, the soft keyboard did not open automatically when reaching the magic code input screen after adding a new contact method. The form was relying on a fixed 300 ms delay before focusing the input, which has no relationship to whether the app window actually holds focus at that moment. Android's documented behavior is to silently drop the keyboard request whenever the window has not regained focus by the time the focus call is made, so the keyboard never appeared. iOS and web were unaffected because they do not have the same window-focus requirement.

The fix replaces the fixed delay with two combined signals. First, the form listens for the navigation transition-end event so it focuses the input exactly when the screen transition finishes (deterministic instead of a guessed timeout). Then it awaits a small helper that resolves only once the app window has regained focus — a no-op on iOS and web, and on Android a Promise tied to the system's window focus events. A safety fallback timer fires if the transition-end event never arrives (for example when the screen is already focused while the effect runs), and a guard flag ensures the listener and the fallback never both run.

The mobile Safari path is intentionally left as a synchronous focus call, because that browser only opens the keyboard when the focus call originates inside the user gesture handler.

Fixed Issues

$ #80025
PROPOSAL: #80025 (comment)

Tests

  1. Sign in on Android Native with a test account.
  2. Navigate to account settings > Profile.
  3. Click on "Contact Method".
  4. Click on "New Contact method".
  5. Enter a valid new email address and click "Add".
  6. Verify the magic code screen is displayed.
  7. Verify the soft keyboard opens automatically (without having to tap the input field).
  8. Enter the magic code received via email and click "Verify" to confirm the input still works as expected.
  • Verify that no errors appear in the JS console

Offline tests

The fix only changes when and how the magic code input is focused after a screen transition; it does not alter any network behavior. With the device offline, opening the magic code screen still focuses the input and opens the keyboard exactly as in the online case (verification of the magic code itself still fails offline as before, since that requires a network request).

QA Steps

Same as Tests.

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message: N/A — no new copy
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native
Kapture.2026-05-16.at.20.15.14.mp4
Android: mWeb Chrome
Kapture.2026-05-16.at.20.24.15.mp4
iOS: Native
Kapture.2026-05-16.at.20.32.39.mp4
iOS: mWeb Safari
Kapture.2026-05-16.at.20.34.35.mp4
MacOS: Chrome / Safari
Kapture.2026-05-16.at.20.26.57.mp4

…oid keyboard

Replaces the deprecated InteractionManager.runAfterInteractions approach with
React Navigation's transitionEnd event listener — the canonical replacement
recommended in contributingGuides/INTERACTION_MANAGER.md and the same pattern
used by useAutoFocusInput across 100+ screens.

Falls back to setTimeout(CONST.SCREEN_TRANSITION_END_TIMEOUT) when
transitionEnd does not fire (e.g. when the screen is already focused).
@codecov

codecov Bot commented May 15, 2026

Copy link
Copy Markdown

Codecov Report

❌ Looks like you've decreased code coverage for some files. Please write tests to increase, or at least maintain, the existing level of code coverage. See our documentation here for how to interpret this table.

Files with missing lines Coverage Δ
...ionModal/ValidateCodeForm/BaseValidateCodeForm.tsx 78.09% <56.25%> (-4.52%) ⬇️
... and 6 files with indirect coverage changes

@wildan-m wildan-m marked this pull request as ready for review May 16, 2026 14:11
@wildan-m wildan-m requested review from a team as code owners May 16, 2026 14:11
@melvin-bot melvin-bot Bot requested review from flaviadefaria and gijoe0295 and removed request for a team May 16, 2026 14:11
@melvin-bot

melvin-bot Bot commented May 16, 2026

Copy link
Copy Markdown

@gijoe0295 Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@melvin-bot melvin-bot Bot removed the request for review from a team May 16, 2026 14:11
Comment thread tests/unit/BaseValidateCodeFormTest.tsx Outdated
};

jest.mock('@react-navigation/native', () => {
// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❌ CONSISTENCY-5 (docs)

The eslint-disable-next-line @typescript-eslint/no-unsafe-assignment directive lacks a justification comment explaining why the rule is disabled.

Add a comment explaining the reason, e.g.:

// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment -- jest.requireActual returns unknown; safe cast for test mock
const actualNav = jest.requireActual('@react-navigation/native');

Reviewed at: 0ac8e59 | Please rate this suggestion with 👍 or 👎 to help us improve! Reactions are used to monitor reviewer efficiency.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Applied in 0dd1382 — added a justification comment to the eslint-disable directive explaining that jest.requireActual returns unknown and this is the standard pattern for spreading the actual module in jest.mock factories.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 0ac8e59061

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment on lines +182 to +186
// Android only opens the soft keyboard once the app window has focus, so we
// chain: wait for the screen transition to finish, then for the window-focus
// signal (a no-op on iOS and web), then focus the input. isCancelled guards
// against a late isWindowReadyToFocus resolution stealing focus after the
// screen has unfocused (e.g. window was blurred when transitionEnd fired).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Android only opens the soft keyboard once the app window has focus, so we
// chain: wait for the screen transition to finish, then for the window-focus
// signal (a no-op on iOS and web), then focus the input. isCancelled guards
// against a late isWindowReadyToFocus resolution stealing focus after the
// screen has unfocused (e.g. window was blurred when transitionEnd fired).
// Android only opens the soft keyboard once the app window has focus.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 0864fee — trimmed to the single line. Kept one short inline comment on the isCancelled check since that guard's reason (avoiding a late focus-steal after blur) isn't obvious from the code alone.

});
};

const unsubscribeTransitionEnd = navigation.addListener?.('transitionEnd', (event) => {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add a null check here too navigation && navigation.addListener.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 0864fee — changed to navigation?.addListener?.('transitionEnd', ...) so it short-circuits if navigation is null, matching the codebase's optional-chaining style.

Comment on lines +209 to +210
// Fallback in case `transitionEnd` does not fire (e.g. when the screen is
// already focused while this effect runs).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Fallback in case `transitionEnd` does not fire (e.g. when the screen is
// already focused while this effect runs).
// Fallback in case `transitionEnd` does not fire.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 0864fee.

Comment thread tests/unit/BaseValidateCodeFormTest.tsx Outdated

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't need this test. This is niche

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the test file in ba9da6e.

@gijoe0295

gijoe0295 commented May 25, 2026

Copy link
Copy Markdown
Contributor

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: HybridApp
Screen.Recording.2026-05-25.at.22.07.19.mov
Android: mWeb Chrome
Screen.Recording.2026-05-25.at.22.38.55.mov
iOS: HybridApp
Screen.Recording.2026-05-25.at.22.42.20.mov
iOS: mWeb Safari
Screen.Recording.2026-05-25.at.22.44.06.mov
MacOS: Chrome / Safari
Screen.Recording.2026-05-25.at.22.45.39.mov

@gijoe0295 gijoe0295 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@melvin-bot melvin-bot Bot requested a review from rlinoz May 28, 2026 08:02
@gijoe0295

Copy link
Copy Markdown
Contributor

@wildan-m Rodrigo should be back from OOO soon. Can you merge main in the meantime?

@wildan-m

wildan-m commented Jun 8, 2026

Copy link
Copy Markdown
Contributor Author

@gijoe0295 Merged main in 03ea049

@rlinoz rlinoz merged commit e4999f8 into Expensify:main Jun 8, 2026
30 checks passed
@OSBotify

OSBotify commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@github-actions

github-actions Bot commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

🚧 @rlinoz has triggered a test Expensify/App build. You can view the workflow run here.

@OSBotify

OSBotify commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/rlinoz in version: 9.4.1-0 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

Bundle Size Analysis (Sentry):

@MelvinBot

Copy link
Copy Markdown
Contributor

Help site review: no changes required

I reviewed the changes in this PR and no updates to the help site (docs/articles) are required.

Why: This PR is a purely technical fix in a single file (BaseValidateCodeForm.tsx). It replaces a fixed 300 ms focus delay with a navigation transitionEnd listener plus an isWindowReadyToFocus check so the soft keyboard opens automatically on Android when reaching the magic code screen.

The change:

  • Adds no user-facing copy, labels, buttons, or settings.
  • Introduces no new feature or workflow.
  • Does not alter any documented user-facing behavior — help articles describe what the contact-method/magic-code flow does, not the underlying input-focus timing. The expected user experience (enter the code, verify) is unchanged.

Since there's nothing for the help site to document differently, I did not open a docs PR.

@wildan-m, if you believe a help site update is still warranted, let me know what behavior should be documented and I'll draft one. Otherwise, no Ready for review action is needed since no help site PR was created.

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 9.4.1-6 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants